<?xml version="1.0" encoding="ISO-8859-1" ?>
<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
    pageEncoding="ISO-8859-1"%>
<%@ taglib prefix="form" uri="http://www.springframework.org/tags/form" %>
<%@ taglib prefix="c" uri="http://java.sun.com/jstl/core_rt" %>
<%@ taglib prefix="fmt" uri="http://java.sun.com/jstl/fmt" %>  
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<!-- meta tags, link to css:  -->
	<%@ include file="../../jsp-includes/mymetaheader.jsp" %>
	
	<!--  Ajax-Includes -->
    <script type='text/javascript' src='<%= request.getContextPath()%>/dwr/interface/DWRUserManager.js'></script>
    <script type='text/javascript' src='<%= request.getContextPath()%>/dwr/interface/DWRSearchManager.js'></script>
    <script type='text/javascript' src='<%= request.getContextPath()%>/dwr/engine.js'></script>
    <script type='text/javascript' src='<%= request.getContextPath()%>/dwr/util.js'></script>
    <script src="<%= request.getContextPath()%>/scriptaculous/prototype.js" type="text/javascript"></script>
	<script src="<%= request.getContextPath()%>/scriptaculous/scriptaculous.js" type="text/javascript"></script>

	<title>
		GroupMe! - Search API
	</title>
	<script type="text/javascript" language="javascript"><!--
	//<![CDATA[//>


function init() {
  DWRUtil.useLoadingMessage();
}

	//<!]]>
	--></script>
</head>
<body onload="init();">
	<!-- title image, logo:  -->
	<div id="groupme_header">
		<%@ include file="../../jsp-includes/groupme_header.jsp" %>
	</div>
	
	<!-- Menu: -->
	<div id="menu">
		<%@ include file="../../jsp-includes/groupme_menu.jsp" %>
	</div>
	<!-- content and sidebar -->
	
  
	<!-- Content: -->
	<div id="mycontent">
		
			<div class="ro_bw">
				<div class="lo_bw">
					<div class="ru_bw">
						<div class="lu_bw">
							<div id="user_groups">
								<div class="content_header" id="grouplist_header" style="padding-top: 2px">
									<small style="color: #006699;">
									<span id="register_header">
										GroupMe! Search API Documentation
									</span> 
									</small>
								</div>
								
								<div class="generalContent" style="">
								<div id="personal-menu" style="padding-bottom: 1em;"><strong>APIs: 
											<a href="../" title="Overview">Overview</a> |
											 <a href="../rest/" title="RESTful API">RESTful API</a> |
											 <a href="../export/" title="Export API">Export API</a> |
											 <a href="../search/" title="Search API">Search API</a></strong>
								</div>
			
			<h2><a name="groupme-api" class="no-link">Search API</a></h2> 
			<p>This GroupMe! API enables client applications to search for resources in GroupMe! and to retrieve the search result 
			as an XML-formatted list.  
			The endpoint of this API is <code><%= VIEW_VOCABULARY.GROUPME_BASE_URL %>api.do</code></p><br/>	
			
			<h3>API Methods</h3>
			<p>Parameter used to specify the method that should be executed: <code>method</code></p><br/>
			
			<div id="api-methods" style="padding-left: 1em;">
			<h4>groupme.search</h4><br/>
			<p>The <strong>search methods</strong> allow to search for GroupMe! groups and resources. We provide the following search methods:</p><br/>
			<ul>
				<li><code>groupme.search</code> - <small>Performs a search for resources and groups.</small></li>
				<li><code>groupme.search.groups</code> - <small> Performs a search for groups only.</small></li>
				<li><code>groupme.search.resources</code> - <small> Performs a search for resources only.</small></li>
			</ul>
			<br/>
			<p><strong>Parameters</strong> and options for GroupMe! search methods:</p><br/>
			<ul>
				<li><code>tag</code> - <small>Mandatory parameter, which allows to specify tags/keywords that should be used as search query. For search methods the specification of at least one tag is mandatory.</small></li>
				<li><code>conjunction</code> - <small> Optional parameter, which enables you to specify how multiple tags are connected. Allowed values: </small><code>or</code> <small>and</small> <code>and</code><small>. If no conjunction is given then the tags are used as OR-connected query.</small> </li>
				<li><code>offset</code> - <small> Optional parameter, which allows to specify how many results of the top k results should be skipped (not returned).</small></li>
				<li><code>limit</code> - <small> Optional parameter, which allows to limit the number of returned results.</small></li>
				<li><code>output</code> - <small> Optional parameter, which allows to specify which output format should be used. Allowed values:</small> <code>xml</code>. <small>Standard output: </small><code>xml</code>. </li>
			</ul>
			<br/>
			<p><strong>Examples:</strong></p><br/>
			<ul>
				<li><a href="<%= VIEW_VOCABULARY.GROUPME_BASE_URL %>api.do?method=groupme.search&tag=web&tag=iswc"><%= VIEW_VOCABULARY.GROUPME_BASE_URL %>api.do?method=groupme.search&tag=web&tag=iswc</a> - <small>Returns GroupMe! groups and resources, which are related to <i>web</i> or <i>iswc</i>. XML is used as standard output format so that the result looks as follows:</small><br/>
<pre>
<code class="api-example">
&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;

&lt;result query="web, iswc" time="Wed May 07 19:57:14 CEST 2008"&gt;

	&lt;resource rank="1" uri="http://groupme.org/GroupMe/resource/111" weburl="http://iswc2007.semanticweb.org/rss/news.rss" 
	                      name="ISWC2007 + ASWC2007" 
	                      description="The 6th International Semantic Web Conference and the 2nd Asian Semantic Web 
	                      Conference, 2007" type="rss"&gt;
		&lt;hasTag tag="news"/&gt;	
		&lt;hasTag tag="semantic web"/&gt;	
		&lt;hasTag tag="iswc"/&gt;	
	&lt;/resource&gt;
	
	&lt;resource rank="2" uri="http://groupme.org/GroupMe/resource/112" 
	                      weburl="http://iswc2007.semanticweb.org/img/ISWC_Top.jpg" 
	                      name="ISWC/ASWC 07 Logo" description="Logo of the ISWC/ASWC 07" type="image"&gt;
		&lt;hasTag tag="iswc"/&gt;	
		&lt;hasTag tag="2007"/&gt;	
		&lt;hasTag tag="aswc"/&gt;	
	&lt;/resource&gt;

	&lt;resource rank="3" uri="http://groupme.org/GroupMe/group/104" name="ISWC 2007" 
	             description="Infos about the International Semantic Web Conference 2007 in Korea" type="group"&gt;
		&lt;hasTag tag="iswc"/&gt;	
		&lt;hasTag tag="web"/&gt;	
		&lt;hasTag tag="semantic web"/&gt;	
		&lt;hasTag tag="aswc"/&gt;	
		&lt;hasTag tag="eslab"/&gt;	
		&lt;hasTag tag="2007"/&gt;	

		&lt;hasResource uri="http://groupme.org/GroupMe/resource/105" 
		                weburl="http://iswc2007.semanticweb.org/img/photo/Barney_Pell.jpg" 
		                name="Barney Pell" 
		                type="image"/&gt;	
		&lt;hasResource uri="http://groupme.org/GroupMe/resource/106" 
		                weburl="http://iswc2007.semanticweb.org/img/photo/chris_welty.jpg" 
		                name="Chris Welty" 
		                type="image"/&gt;	
		&lt;hasResource uri="http://groupme.org/GroupMe/resource/107" 
		                weburl="http://iswc2007.semanticweb.org/" 
		                name="iswc 2007" 
		                type="website"/&gt;	
		&lt;hasResource uri="http://groupme.org/GroupMe/resource/108" 
		                weburl="http://static.flickr.com/90/243820601_ae4014f569.jpg" 
		                name="Gwangalli Beach" 
		                type="image"/&gt;	
		&lt;hasResource uri="http://groupme.org/GroupMe/resource/110" 
		                weburl="http://static.flickr.com/137/406287530_b0f1340fb1.jpg" 
		                name="busy Busan" 
		                type="image"/&gt;	
		&lt;hasResource uri="http://groupme.org/GroupMe/resource/111" 
		                weburl="http://iswc2007.semanticweb.org/rss/news.rss" 
		                name="ISWC2007 + ASWC2007" 
		                type="rss"/&gt;	
	&lt;/resource&gt;
&lt;/result&gt;
				</code>
				</pre>
				</li>
				<li><a href="<%= VIEW_VOCABULARY.GROUPME_BASE_URL %>api.do?method=groupme.search&tag=web&tag=iswc"><%= VIEW_VOCABULARY.GROUPME_BASE_URL %>api.do?method=groupme.search&tag=web&tag=iswc</a> - <small>Click on the link to see the result :) </small> </li>
			</ul>
			<br/>
			
								</div>
							</div>
						</div>
					</div>
				</div>
			</div>
		
	</div>
	
	<div id="footer">
		<%@ include file="../../jsp-includes/footer.jsp" %>
	</div>
</body>
</html>